﻿using System;

#region MIT License text
/*
Copyright (c) 2009 Mark van Straten - Q42 B.V.

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
*/
#endregion

namespace Q42.Wheels.Api.Nabaztag
{
    /// <summary>
    /// Abstract base class for Geography's
    /// </summary>
    public abstract class ChoreographyPart
    {
        /// <summary>
        /// Time when this action will play. 
        /// </summary>
        private Int16 actionTime;
        /// <summary>
        /// Time when this action will play. 
        /// </summary>
        protected Int16 ActionTime
        {
            get { return actionTime; }
            private set
            {
                if (value < 0)
                    throw new ArgumentOutOfRangeException("ActionTime must be >= 0");
                actionTime = value;
            }
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="oActionTime">The time in the choreography when this action will be triggered.</param>
        public ChoreographyPart(Int16 oActionTime)
        {
            actionTime = oActionTime;
        }

        /// <summary>
        /// Return the choreograpy for the Nabaztag/tag API in URL form
        /// </summary>
        /// <returns></returns>
        public abstract String GetChoreoGraphy();
    }
}
